Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Schedule monthly review of publicly accessible content (#6051) #6440

Merged

Conversation

achave11-ucsc
Copy link
Member

@achave11-ucsc achave11-ucsc commented Jul 23, 2024

Connected issues: #6051

Checklist

Author

  • PR is a draft
  • Target branch is develop
  • Name of PR branch matches issues/<GitHub handle of author>/<issue#>-<slug>
  • On ZenHub, PR is connected to all issues it (partially) resolves
  • PR description links to connected issues
  • PR title matches1 that of a connected issue or comment in PR explains why they're different
  • PR title references all connected issues
  • For each connected issue, there is at least one commit whose title references that issue

1 when the issue title describes a problem, the corresponding PR
title is Fix: followed by the issue title

Author (partiality)

  • Added p tag to titles of partial commits
  • This PR is labeled partial or completely resolves all connected issues
  • This PR partially resolves each of the connected issues or does not have the partial label

Author (chains)

  • This PR is blocked by previous PR in the chain or is not chained to another PR
  • The blocking PR is labeled base or this PR is not chained to another PR
  • This PR is labeled chained or is not chained to another PR

Author (reindex, API changes)

  • Added r tag to commit title or the changes introduced by this PR will not require reindexing of any deployment
  • This PR is labeled reindex:dev or the changes introduced by it will not require reindexing of dev
  • This PR is labeled reindex:anvildev or the changes introduced by it will not require reindexing of anvildev
  • This PR is labeled reindex:anvilprod or the changes introduced by it will not require reindexing of anvilprod
  • This PR is labeled reindex:prod or the changes introduced by it will not require reindexing of prod
  • This PR is labeled reindex:partial and its description documents the specific reindexing procedure for dev, anvildev, anvilprod and prod or requires a full reindex or carries none of the labels reindex:dev, reindex:anvildev, reindex:anvilprod and reindex:prod
  • This PR and its connected issues are labeled API or this PR does not modify a REST API
  • Added a (A) tag to commit title for backwards (in)compatible changes or this PR does not modify a REST API
  • Updated REST API version number in app.py or this PR does not modify a REST API

Author (upgrading deployments)

  • Ran make image_manifests.json and committed the resulting changes or this PR does not modify azul_docker_images, or any other variables referenced in the definition of that variable
  • Documented upgrading of deployments in UPGRADING.rst or this PR does not require upgrading deployments
  • Added u tag to commit title or this PR does not require upgrading deployments
  • This PR is labeled upgrade or does not require upgrading deployments
  • This PR is labeled deploy:shared or does not modify image_manifests.json, and does not require deploying the shared component for any other reason
  • This PR is labeled deploy:gitlab or does not require deploying the gitlab component
  • This PR is labeled deploy:runner or does not require deploying the runner image

Author (hotfixes)

  • Added F tag to main commit title or this PR does not include permanent fix for a temporary hotfix
  • Reverted the temporary hotfixes for any connected issues or the none of the stable branches (anvilprod and prod) have temporary hotfixes for any of the issues connected to this PR

Author (before every review)

  • Rebased PR branch on develop, squashed old fixups
  • Ran make requirements_update or this PR does not modify requirements*.txt, common.mk, Makefile and Dockerfile
  • Added R tag to commit title or this PR does not modify requirements*.txt
  • This PR is labeled reqs or does not modify requirements*.txt
  • make integration_test passes in personal deployment or this PR does not modify functionality that could affect the IT outcome

Peer reviewer (after approval)

  • PR is not a draft
  • Ticket is in Review requested column
  • PR is awaiting requested review from system administrator
  • PR is assigned to only the system administrator

System administrator (after approval)

  • Actually approved the PR
  • Labeled connected issues as demo or no demo
  • Commented on connected issues about demo expectations or all connected issues are labeled no demo
  • Decided if PR can be labeled no sandbox
  • A comment to this PR details the completed security design review
  • PR title is appropriate as title of merge commit
  • N reviews label is accurate
  • Moved ticket to Approved column
  • PR is assigned to only the operator

Operator (before pushing merge the commit)

  • Checked reindex:… labels and r commit title tag
  • Checked that demo expectations are clear or all connected issues are labeled no demo
  • Squashed PR branch and rebased onto develop
  • Sanity-checked history
  • Pushed PR branch to GitHub
  • Ran _select dev.shared && CI_COMMIT_REF_NAME=develop make -C terraform/shared apply_keep_unused or this PR is not labeled deploy:shared
  • Ran _select dev.gitlab && CI_COMMIT_REF_NAME=develop make -C terraform/gitlab apply or this PR is not labeled deploy:gitlab
  • Ran _select anvildev.shared && CI_COMMIT_REF_NAME=develop make -C terraform/shared apply_keep_unused or this PR is not labeled deploy:shared
  • Ran _select anvildev.gitlab && CI_COMMIT_REF_NAME=develop make -C terraform/gitlab apply or this PR is not labeled deploy:gitlab
  • Checked the items in the next section or this PR is labeled deploy:gitlab
  • PR is assigned to only the system administrator or this PR is not labeled deploy:gitlab

System administrator

  • Background migrations for dev.gitlab are complete or this PR is not labeled deploy:gitlab
  • Background migrations for anvildev.gitlab are complete or this PR is not labeled deploy:gitlab
  • PR is assigned to only the operator

Operator (before pushing merge the commit)

  • Ran _select dev.gitlab && make -C terraform/gitlab/runner or this PR is not labeled deploy:runner
  • Ran _select anvildev.gitlab && make -C terraform/gitlab/runner or this PR is not labeled deploy:runner
  • Added sandbox label or PR is labeled no sandbox
  • Pushed PR branch to GitLab dev or PR is labeled no sandbox
  • Pushed PR branch to GitLab anvildev or PR is labeled no sandbox
  • Build passes in sandbox deployment or PR is labeled no sandbox
  • Build passes in anvilbox deployment or PR is labeled no sandbox
  • Reviewed build logs for anomalies in sandbox deployment or PR is labeled no sandbox
  • Reviewed build logs for anomalies in anvilbox deployment or PR is labeled no sandbox
  • Deleted unreferenced indices in sandbox or this PR does not remove catalogs or otherwise causes unreferenced indices in dev
  • Deleted unreferenced indices in anvilbox or this PR does not remove catalogs or otherwise causes unreferenced indices in anvildev
  • Started reindex in sandbox or this PR is not labeled reindex:dev
  • Started reindex in anvilbox or this PR is not labeled reindex:anvildev
  • Checked for failures in sandbox or this PR is not labeled reindex:dev
  • Checked for failures in anvilbox or this PR is not labeled reindex:anvildev
  • The title of the merge commit starts with the title of this PR
  • Added PR # reference to merge commit title
  • Collected commit title tags in merge commit title but only included p if the PR is also labeled partial
  • Moved connected issues to Merged lower column in ZenHub
  • Pushed merge commit to GitHub

Operator (chain shortening)

  • Changed the target branch of the blocked PR to develop or this PR is not labeled base
  • Removed the chained label from the blocked PR or this PR is not labeled base
  • Removed the blocking relationship from the blocked PR or this PR is not labeled base
  • Removed the base label from this PR or this PR is not labeled base

Operator (after pushing the merge commit)

  • Pushed merge commit to GitLab dev
  • Pushed merge commit to GitLab anvildev
  • Build passes on GitLab dev
  • Reviewed build logs for anomalies on GitLab dev
  • Build passes on GitLab anvildev
  • Reviewed build logs for anomalies on GitLab anvildev
  • Ran _select dev.shared && make -C terraform/shared apply or this PR is not labeled deploy:shared
  • Ran _select anvildev.shared && make -C terraform/shared apply or this PR is not labeled deploy:shared
  • Deleted PR branch from GitHub
  • Deleted PR branch from GitLab dev
  • Deleted PR branch from GitLab anvildev

Operator (reindex)

  • Deindexed all unreferenced catalogs in dev or this PR is neither labeled reindex:partial nor reindex:dev
  • Deindexed all unreferenced catalogs in anvildev or this PR is neither labeled reindex:partial nor reindex:anvildev
  • Deindexed specific sources in dev or this PR is neither labeled reindex:partial nor reindex:dev
  • Deindexed specific sources in anvildev or this PR is neither labeled reindex:partial nor reindex:anvildev
  • Indexed specific sources in dev or this PR is neither labeled reindex:partial nor reindex:dev
  • Indexed specific sources in anvildev or this PR is neither labeled reindex:partial nor reindex:anvildev
  • Started reindex in dev or this PR does not require reindexing dev
  • Started reindex in anvildev or this PR does not require reindexing anvildev
  • Checked for, triaged and possibly requeued messages in both fail queues in dev or this PR does not require reindexing dev
  • Checked for, triaged and possibly requeued messages in both fail queues in anvildev or this PR does not require reindexing anvildev
  • Emptied fail queues in dev or this PR does not require reindexing dev
  • Emptied fail queues in anvildev or this PR does not require reindexing anvildev

Operator

  • Propagated the deploy:shared, deploy:gitlab, deploy:runner, API, reindex:partial, reindex:anvilprod and reindex:prod labels to the next promotion PRs or this PR carries none of these labels
  • Propagated any specific instructions related to the deploy:shared, deploy:gitlab, deploy:runner, API, reindex:partial, reindex:anvilprod and reindex:prod labels, from the description of this PR to that of the next promotion PRs or this PR carries none of these labels
  • PR is assigned to no one

Shorthand for review comments

  • L line is too long
  • W line wrapping is wrong
  • Q bad quotes
  • F other formatting problem

@github-actions github-actions bot added the orange [process] Done by the Azul team label Jul 23, 2024
@coveralls
Copy link

coveralls commented Jul 23, 2024

Coverage Status

coverage: 85.434%. remained the same
when pulling 6b57740 on issues/achave11-ucsc/6051-review-public-acc-content
into b1fd8e6 on develop.

Copy link

codecov bot commented Jul 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.41%. Comparing base (b1fd8e6) to head (6b57740).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #6440   +/-   ##
========================================
  Coverage    85.41%   85.41%           
========================================
  Files          156      156           
  Lines        20682    20682           
========================================
  Hits         17666    17666           
  Misses        3016     3016           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

dsotirho-ucsc
dsotirho-ucsc previously approved these changes Jul 23, 2024
Copy link
Contributor

@dsotirho-ucsc dsotirho-ucsc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved.

@dsotirho-ucsc dsotirho-ucsc marked this pull request as ready for review July 23, 2024 18:11
Copy link
Member

@hannes-ucsc hannes-ucsc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How was this tested?

@@ -0,0 +1,11 @@
---
name: Review publicly accessible content
about: 'Issue template for the system administrator to perform a review of publicly accessible content.'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this quoted?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Convention. Since all the other issue templates use quotes for this property, I figured that was the standard.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't think of a reason as to why we would have that convention. I think this is just incidental.

Please remove all unnecessary quotes from these templates in a separate commit.

@hannes-ucsc hannes-ucsc removed their assignment Jul 31, 2024
@hannes-ucsc hannes-ucsc added the 0 reviews [process] Lead didn't request any changes label Jul 31, 2024
@achave11-ucsc
Copy link
Member Author

I validated this by verifying the 'Would run' logs when running …

python .github/workflows/schedule.py --dry-run
envhook.py: Warning: GITHUB_TOKEN is 'REDACTED' but should be 'REDACTED', you must run `source environment`
2024-07-31 13:24:42,273    INFO azul.github.schedule: Running ['gh', 'issue', 'list', '--search=in:title "Review rule set for audited events 2024-07-31"', '--json=number', '--limit=10']
2024-07-31 13:24:43,032    INFO azul.github.schedule: Would run ['gh', 'issue', 'create', '--assignee=nolunwa-ucsc,bvizzier-ucsc', '--title=Review rule set for audited events 2024-07-31', '--label=-,compliance,doc,no demo,orange,task', '--body=- [ ] PM (@bvizzier-ucsc) and @nolunwa-ucsc, scheduled a meeting for the annual review of the rule set for audited events\n']
2024-07-31 13:24:43,034    INFO azul.github.schedule: Ignoring issue template .github/ISSUE_TEMPLATE/blank.md since it defines no schedule.
2024-07-31 13:24:43,035    INFO azul.github.schedule: Running ['gh', 'issue', 'list', '--repo=DataBiosphere/azul-private', '--search=in:title "Monthly review of publicly accessible content 2024-07-31"', '--json=number', '--limit=10']
2024-07-31 13:24:43,506    INFO azul.github.schedule: Would run ['gh', 'issue', 'create', '--repo=DataBiosphere/azul-private', '--assignee=hannes-ucsc', '--title=Monthly review of publicly accessible content 2024-07-31', '--label=-,compliance,infra,doc,orange,task', '--body=It is time for the system administrator to review publicly accessible content in all deployments.\n']
…
2024-07-31 13:24:44,019    INFO azul.github.schedule: Running ['gh', 'issue', 'list', '--search=in:title "Promotion 2024-07-31"', '--json=number', '--limit=10']
2024-07-31 13:24:44,480    INFO azul.github.schedule: Would run ['gh', 'issue', 'create', '--title=Promotion 2024-07-31', '--label=-,infra,no demo,operator,orange,task', '--body=- [ ] The title of this issue matches `Promotion yyyy-mm-dd`\n- [ ] For `prod`\n  - [ ] System administrator and operator determined the commit to be promoted\n  - [ ] Operator created the promotion PR\n- [ ] For `anvilprod`\n  - [ ] System administrator and operator determined the commit to be promoted\n  - [ ] Operator created the promotion PR\n']
2024-07-31 13:24:44,482    INFO azul.github.schedule: Running ['gh', 'issue', 'list', '--repo=DataBiosphere/azul-private', '--search=in:title "Monthly inventory review 2024-07-31"', '--json=number', '--limit=10']
2024-07-31 13:24:44,961    INFO azul.github.schedule: Would run ['gh', 'issue', 'create', '--repo=DataBiosphere/azul-private', '--assignee=hannes-ucsc', '--title=Monthly inventory review 2024-07-31', '--label=+,compliance,infra,no demo,operator,orange,task', '--body=It is time for the system administrator to review the FedRAMP inventory and perform a Port and Protocol review in all deployments\n\n\n- [ ] Collect most recent `dev` inventories and attach them to this issue\n- [ ] Collect most recent `anvildev` inventories and attach them to this issue\n- [ ] Collect most recent `anvilprod` inventories and attach them to this issue\n- [ ] Collect most recent `prod` inventories and attach them to this issue\n\n- [ ] Reviewed `dev` inventory\n- [ ] Reviewed `anvildev` inventory\n- [ ] Reviewed `anvilprod` inventory\n- [ ] Reviewed `prod` inventory\n']

… of this new issue template …

Would run ['gh', 'issue', 'create', '--repo=DataBiosphere/azul-private', '--assignee=hannes-ucsc', '--title=Monthly review of publicly accessible content 2024-07-31', '--label=-,compliance,infra,doc,orange,task', '--body=It is time for the system administrator to review publicly accessible content in all deployments.\n']

… and a preexisting template, for the same azul-private repository, and that we are certain works

Would run ['gh', 'issue', 'create', '--repo=DataBiosphere/azul-private', '--assignee=hannes-ucsc', '--title=Monthly inventory review 2024-07-31', '--label=+,compliance,infra,no demo,operator,orange,task', '--body=It is time for the system administrator to review the FedRAMP inventory and perform a Port and Protocol review in all deployments\n\n\n- [ ] Collect most recent dev inventories and attach them to this issue\n- [ ] Collect most recent anvildev inventories and attach them to this issue\n- [ ] Collect most recent anvilprod inventories and attach them to this issue\n- [ ] Collect most recent prod inventories and attach them to this issue\n\n- [ ] Reviewed dev inventory\n- [ ] Reviewed anvildev inventory\n- [ ] Reviewed anvilprod inventory\n- [ ] Reviewed prod inventory\n']

… and confirmed the similarity in the structure of the gh issue create command in both instances.

@@ -0,0 +1,11 @@
---
name: Review publicly accessible content
about: 'Issue template for the system administrator to perform a review of publicly accessible content.'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't think of a reason as to why we would have that convention. I think this is just incidental.

Please remove all unnecessary quotes from these templates in a separate commit.

@nadove-ucsc nadove-ucsc added the no sandbox [process] PR will not be tested in the sandbox label Aug 10, 2024
@nadove-ucsc
Copy link
Contributor

Security design review

  • Security design review completed; this PR does not
    • … affect authentication; for example:
      • OAuth 2.0 with the application (API or Swagger UI)
      • Authentication of developers with Google Cloud APIs
      • Authentication of developers with AWS APIs
      • Authentication with a GitLab instance in the system
      • Password and 2FA authentication with GitHub
      • API access token authentication with GitHub
      • Authentication with Terra
    • … affect the permissions of internal users like access to
      • Cloud resources on AWS and GCP
      • GitLab repositories, projects and groups, administration
      • an EC2 instance via SSH
      • GitHub issues, pull requests, commits, commit statuses, wikis, repositories, organizations
    • … affect the permissions of external users like access to
      • TDR snapshots
    • … affect permissions of service or bot accounts
      • Cloud resources on AWS and GCP
    • … affect audit logging in the system, like
      • adding, removing or changing a log message that represents an auditable event
      • changing the routing of log messages through the system
    • … affect monitoring of the system
    • … introduce a new software dependency like
      • Python packages on PYPI
      • Command-line utilities
      • Docker images
      • Terraform providers
    • … add an interface that exposes sensitive or confidential data at the security boundary
    • … affect the encryption of data at rest
    • … require persistence of sensitive or confidential data that might require encryption at rest
    • … require unencrypted transmission of data within the security boundary
    • … affect the network security layer; for example by
      • modifying, adding or removing firewall rules
      • modifying, adding or removing security groups
      • changing or adding a port a service, proxy or load balancer listens on
  • Documentation on any unchecked boxes is provided in comments below

@achave11-ucsc achave11-ucsc force-pushed the issues/achave11-ucsc/6051-review-public-acc-content branch from 88880ee to 6b57740 Compare August 12, 2024 21:18
@hannes-ucsc hannes-ucsc merged commit c6699c0 into develop Aug 12, 2024
9 checks passed
@achave11-ucsc achave11-ucsc deleted the issues/achave11-ucsc/6051-review-public-acc-content branch August 12, 2024 23:12
@achave11-ucsc achave11-ucsc removed their assignment Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0 reviews [process] Lead didn't request any changes no sandbox [process] PR will not be tested in the sandbox orange [process] Done by the Azul team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants